home *** CD-ROM | disk | FTP | other *** search
/ Assassins - Ultimate CD Games Collection 3 / Assassins 3 - The Ultimate Games CD (1997)(Weird Science)[!][Amiga-CD32-CDTV].iso / puzzles / klaz / ki.doc < prev    next >
Text File  |  1995-10-23  |  18KB  |  430 lines
  1. ----------------------------------------------------------------------------
  2. KI
  3. ----------------------------------------------------------------------------
  4.  
  5.                                    KI V1.3
  6.  
  7.                              '© Arnold Schommer'
  8.  
  9.  
  10.      '' Introduction
  11.      '' Objective of the Game
  12.      '' CLI- and Workbench-parameters
  13.      '' customizing the values during the program
  14.      '' Keyboard- and joystick-controls of the game
  15.  
  16.      '' System requirements / Installing
  17.      '' Overview of files
  18.  
  19.      '' Known Bugs (check this before registering)
  20.      '' Registration
  21.      '' Copyright etc.
  22.      '' Miscellaneous
  23.  
  24.  
  25. ----------------------------------------------------------------------------
  26. Introduction
  27. ----------------------------------------------------------------------------
  28.  
  29.     KI is a thinking game on one hand related to "Klax"/"KlakTris" (or
  30.     as whatever you know this gametype): You drop tiles and as soon as
  31.     three equal squares build a row, they vanish. On the  other  hand,
  32.     it is related to "Ishido" because the single squares are not  only
  33.     different by colour but have a second property.  So  the  name  is
  34.     derived from these two "parents".
  35.  
  36.     Furthermore, KI is in wide ranges configurable.
  37.  
  38.  
  39. ----------------------------------------------------------------------------
  40. "System requirements / Installing"
  41. ----------------------------------------------------------------------------
  42.  
  43.     KI should work on any Amiga from Kickstart 1.3  on.  (But  it  was
  44.     mainly tested on a 2000B with Kickstart 2.1, A2630 and 4/0.5MB  of
  45.     memory)
  46.     512KB graphics memory should be enough; if you have problems, try
  47.     to play without music (see 'NOMUSIC-parameter').
  48.  
  49.     Installing:
  50.  
  51.     'For Kickstart 1.3'
  52.  
  53.     'For Kickstart 2.0'
  54.  
  55.     'For Kickstart 2.1' and above (correctly: Workbench 2.1)
  56.  
  57.  
  58.     'Notes for registering users'
  59.  
  60.  
  61. ----------------------------------------------------------------------------
  62. "Installing KI for Kickstart 1.3"
  63. ----------------------------------------------------------------------------
  64.  
  65.     First, extract the archive to the  drawer  you  want  to  have  it
  66.     installed  in.  Delete  the  subdirectory  "Catalogs"   with   its
  67.     contents. Move the files "tracker.library" and "medplayer.library"
  68.     into your "libs:"-drawer.
  69.     For those lazy people who prefer things to GET installed:  Copying
  70.     the  libraries  to  "libs:"  may  be  done  by   the   script-file
  71.     "InstallLibs", but this does not check if you  already  have  more
  72.     recent versions of them.
  73.  
  74.  
  75. ----------------------------------------------------------------------------
  76. "Installing KI for Kickstart 2.0"
  77. ----------------------------------------------------------------------------
  78.  
  79.     Extract the archive to wherever you want it.
  80.     Delete the subdirectory "Catalogs" with its contents.
  81.  
  82.  
  83. ----------------------------------------------------------------------------
  84. "Installing KI for Kickstart 2.1 and above"
  85. ----------------------------------------------------------------------------
  86.  
  87.     Extract the archive to wherever you want it.
  88.  
  89.  
  90. ----------------------------------------------------------------------------
  91. "Notes for registering users"
  92. ----------------------------------------------------------------------------
  93.  
  94.     * You get a disk containing all  files  unpacked,  so  instead  of
  95.       extracting an archive, you have to move some data (e.g. via  the
  96.       Workbench).
  97.  
  98.     * If you do not want to look which files really have  changed  and
  99.       copy them blindly, don't forget to save  your  highscores  (from
  100.       the demo-version) ! They are recorded in the file "KI-Scores".
  101.  
  102.  
  103. ----------------------------------------------------------------------------
  104. "Overview of files"
  105. ----------------------------------------------------------------------------
  106.  
  107.     The archive (unregistered version, of course) should  contain  the
  108.     following files (icons omitted):
  109.  
  110.     KI                  the main program
  111.     KI-Music.MED        the default music for the game
  112.     KI-Scores           an initial Highscore-file
  113.     KI-Tiles.iff        the default square-graphics for the game
  114.     tracker.library     a shared library required by KI
  115.     medplayer.library   a shared library required by KI
  116.     Catalogs/*/*        program-texts (currently only german)
  117.  
  118.     KI.guide            this description (HyperText-format)
  119.     KI.doc              this description (plain text, generated
  120.                         automatically from the HyperText-file)
  121.     KI.cd               a description of the programs text to
  122.                         enable you to create 'translations'
  123.     InstallLibs         see 'Installing KI for Kickstart 1.3'
  124.     BugReport           a BugReport form
  125.     Registration        a Registration form
  126.  
  127.  
  128. ----------------------------------------------------------------------------
  129. Terms
  130. ----------------------------------------------------------------------------
  131.  
  132.     The things that fall down, are called  "tiles".  They  consist  of
  133.     one or more "squares" (which may look very different from  squares
  134.     anyway). Each square has two properties, a "colour" and a  "kind".
  135.     The kind should define the the geometry of the squares.
  136.  
  137.  
  138. ----------------------------------------------------------------------------
  139. "Objective of the Game"
  140. ----------------------------------------------------------------------------
  141.  
  142.     You get slowly dropping 'tiles' consisting of one  or  more  'squares'
  143.     and have to place them in the rectangular playfield. The aim is to
  144.     place as many tiles as possible until the playfield is that  full,
  145.     that there is no space left for new tiles.
  146.     With what i told you up to know, you knew that the game had to end
  147.     after a more or less obvious number of tiles.  But  if  a  certain
  148.     number of swuares in a horizontal, vertical or diagonal  row  have
  149.     the same colour or type, they vanish and the squares  above  slide
  150.     down into the gaps.
  151.  
  152.  
  153. ----------------------------------------------------------------------------
  154. "using own music files"
  155. ----------------------------------------------------------------------------
  156.  
  157.     The bad news: KI can't use SoundTracker-files. (I'm sorry,  but  i
  158.     have no playing routines for these).
  159.     The supported filetype is the module-format of MED.
  160.  
  161.     Registered users get  MED  if  they  wish  to  convert  their  own
  162.     SoundTracker-modules - see 'MED.doc'.
  163.  
  164.  
  165. ----------------------------------------------------------------------------
  166. "using own squares"
  167. ----------------------------------------------------------------------------
  168.  
  169.     The file containing the graphics for the  squares  has  to  be  an
  170.     IFF-ILBM-Picture.
  171.     The squares have to be arranged side  by  side  in  the  following
  172.     manner: different kinds are in a row, if necessary  with  gaps  so
  173.     that the left edge of each square has a coordinate divisible by 8;
  174.     different colours are in a column without gap.
  175.     If the square-size differs from 16*16 pixels, you have  either  to
  176.     use the parameters TILEWIDTH/TILEHEIGHT or to add a TILE-Chunk  to
  177.     the file. The number of available colours and kinds will  then  be
  178.     computed.
  179.  
  180.     Registered users get a Program 'AddTileChunk' to apend a  TILE-Chunk
  181.     to an existing graphics-file.
  182.  
  183.  
  184. ----------------------------------------------------------------------------
  185. "CLI- and Workbench-parameters"
  186. ----------------------------------------------------------------------------
  187.  
  188.     KI may be run from the workbench or in a CLI. At starting via CLI,
  189.     the following parameters are supported:
  190.  
  191.     NOMUSIC:
  192.         No music is loaded and played.
  193.  
  194.     MUSIC <filename>:
  195.         The program tries to play the music <filename>.
  196.         If neither this nor the previous parameter is  used,  this  is
  197.         handled like "MUSIC KI-Music.MED".
  198.         See also 'using own music files'.
  199.  
  200.     TILES <filename>:
  201.         The square-graphics are taken from  the  file  <filename>.  If
  202.         this parameter is not used, the file "KI-Tiles.iff" is used.
  203.         See also 'using own squares'.
  204.  
  205.     TILEWIDTH <n>:
  206.         The width of the squares is <n> instead of 16 pixels.
  207.  
  208.     TILEHEIGHT <n>:
  209.         The height of the squares is <n> instead of 16 pixels.
  210.  
  211.     HIRES / INTERLACE / HAM / EHB:
  212.         The given ViewMode shall be used.
  213.  
  214.     At starting KI via Workbench, the same parameters are allowed  but
  215.     they have be used as ToolTypes of the program itself  or  an  icon
  216.     which has to be in the same drawer.
  217.     The parameters are specified in the for ToolTypes usual  way:  The
  218.     keyword is followed by an equal and  the  parameter  itself.  E.g.
  219.     a ToolType-entry "MUSIC=test.MED"  means  the  same  as  the  part
  220.     "MUSIC test.MED" of an CLI-call.
  221.  
  222.  
  223. ----------------------------------------------------------------------------
  224. "AddTileChunk © Arnold Schommer"
  225. ----------------------------------------------------------------------------
  226.  
  227.     Apart from a square-size differing from 16*16 pixels, with a TILE-
  228.     Chunk certain ViewModes as HAM, EHB may be forced.
  229.  
  230.     AddTileChunk can append such a TILE-Chunk to an existing IFF-file.
  231.     Graphics-programs should not  bother  about  this  Chunk,  but  if
  232.     editing the graphics, one has to remember that no  graphics-editor
  233.     will write it during saving the graphics.
  234.  
  235.     AddTileChunk can only be started in a CLI. It knows the  following
  236.     parameters:
  237.  
  238.     [FILE] <filename>                   (this parameter must be given)
  239.         Tells the name of the graphics to be extended. No backup  will
  240.         be created. In general, this should be unneccessary since  the
  241.         file does not get faulty for other programs according  to  the
  242.         IFF-specifications.
  243.  
  244.     WIDTH <w>                           (this parameter must be given)
  245.         Tells the width of the squares. Up to  now,  this  has  to  be
  246.         divisible by 8.
  247.  
  248.     HEIGHT <h>                          (this parameter must be given)
  249.         Tells the height of the squares.
  250.  
  251.     VFLAGS <n>
  252.         Defines required ViewModes.
  253.         Better use HIRES, LACE, HAM and EHB.
  254.  
  255.     HIRES
  256.         The squares have to be displayed in high resolution.
  257.         In this case only 16, not 32 or - with EHB -  64  colours  are
  258.         available.
  259.         This may be sensible if the squares are very  wide  and  would
  260.         only allow a tiny playfield in low resolution.
  261.  
  262.     LACE
  263.         The squares have to  be  displayed  in  interlace,  with  high
  264.         vertical resolution.
  265.         This may be sensible if the squares are very  tall  and  would
  266.         only allow a tiny playfield in low resolution.
  267.  
  268.     HAM
  269.         The squares have to be displayed in  the  so-called  hold-and-
  270.         modify-mode.
  271.         (KI does NOT recognize this from a plain IFF-file)
  272.     EHB
  273.         The squares have to  be  displayed  in  the  so-called  extra-
  274.         halfbrite-mode.
  275.         (KI does NOT recognize this from a plain IFF-file)
  276.  
  277.     There are some further parameters AddTileChunk already knows,  but
  278.     KI does not yet support them.
  279.  
  280.     A word on the ViewModes:
  281.     * I have an old Amiga, not even with ECS. That means, i think many
  282.       of the things being normal with AGA may seem forbidden to me.
  283.     * KI ignores all informations concerning  the  ViewMode  it  might
  284.       find in the graphics-file - apart from the TILE-Chunk,  which  i
  285.       designed only for this purpose.
  286.       About  HIRES  and  LACE  i  simply  think  that   the   original
  287.       resolution, used during painting the squares, is irrelevant  for
  288.       playing, and in case of HAM and EHB the IFF-definitions  do  not
  289.       tell in every case how to decide which of the two is wanted.  By
  290.       the way (did you forget ?): KI is no graphics-program -  so  why
  291.       to mess around with these details.
  292.  
  293.  
  294. ----------------------------------------------------------------------------
  295. "customizing the values after starting"
  296. ----------------------------------------------------------------------------
  297.  
  298.     With the menu you are able to set the most important parameters of
  299.     the game: How many of the (grafically defined) square-colours  and
  300.     -kinds shall occur in the game, how large the  playfield  and  the
  301.     tiles shall be, how large rows have be to vanish and how  fast  or
  302.     slow the tiles shall be dropped.
  303.  
  304.     The Gadgets can also be used via keyboard. To do this, you have to
  305.     type the letter display lighter:  small  to  increase  the  value,
  306.     large to decrease it (no matter, how the letter is displayed).
  307.     All these values but the falldelay lead to independent  Highscore-
  308.     recordings !
  309.  
  310.     You can quit the program with Escape (after  a  security-request),
  311.     too.
  312.     The game can also be started by pressing Space,  Return,  numkey-5
  313.     or the fire button of the joystick.
  314.  
  315.  
  316. ----------------------------------------------------------------------------
  317. "Keyboard- and joystick-controls during the game"
  318. ----------------------------------------------------------------------------
  319.  
  320.     The horizontal cursor-keys and 4 and 6 on the numeric keypad  move
  321.     the tile aside.
  322.     With Space, numkey-5 the squares of the tile get  exchanged:  each
  323.     square is moved one position down, and the one at the bottom  gets
  324.     atop.
  325.     With Return Enter, cursor-down or numkey-2 the tile  gets  dropped
  326.     faster - without a chance to move it aside after this.
  327.     With the letter shown in the gadget, Help, cursor-up  or  numkey-8
  328.     you get a break which is ended with any keypress.
  329.     The gadgets at the  right  bottom  should  be  clear.  "Falldelay"
  330.     controls the speed of the tile sliding down.
  331.     You can quit the game with Escape (after a security-request), too.
  332.  
  333.     The four basic  directions  of  the  joystick  correspond  to  the
  334.     cursor-keys and the fire-button corresponds to numkey-5.
  335.     I.e., you can start the game with fire; right/left moves the  tile
  336.     in this direction; up makes a break  which  may  be  left  by  any
  337.     joystick-move; down drops the tile faster.
  338.  
  339.  
  340. ----------------------------------------------------------------------------
  341. "Known Bugs"
  342. ----------------------------------------------------------------------------
  343.  
  344.     * KI is quite processor-time-wasting. That means, on an Amiga with
  345.       68000 the graphics somtimes flickers !
  346.     * If squares slide into gaps, the marking-dots in  the  background
  347.       slide with them.
  348.     * If the music can not be played, the user is not told why.
  349.       Possible reasons:
  350.       - A missing "medplayer.library" (see 'installing')
  351.       - The playing-routine can't get control over the soundchip, e.g.
  352.         if there is an active music-program.
  353.       - Lack of memory (as far as i know, music-files are loaded  into
  354.         ChipRAM)
  355.       - Wrong type of music-file (see 'using own music files')
  356.  
  357.  
  358. ----------------------------------------------------------------------------
  359. Registration
  360. ----------------------------------------------------------------------------
  361.  
  362.     The Shareware-fee if 10,- DM (about 6.50 US$) (including postage).
  363.     Details see the file 'Registration', which may also  be  used  as  a
  364.     form; please read carefully !
  365.  
  366.     The registered version of KI  contains  in  the  Highscore-display
  367.     instead of "Demo for ..." the text "registered for  ..."  and  the
  368.     name of the registered  user  and  the  somtimes  upcoming  "Don't
  369.     forget to register !"-requesters are omitted.
  370.  
  371.     Furthermore, registered users get:
  372.     - additional square-graphics
  373.     - additional music-files
  374.       - or -
  375.       MED3.00 from Fish-Disk #476 to be able to convert  SoundTracker-
  376.       modules.
  377.     - The utility 'AddTileChunk' to be  able  to  use  non-16*16-squares
  378.       without separate parameters.
  379.  
  380.  
  381. ----------------------------------------------------------------------------
  382. "Copyright etc."
  383. ----------------------------------------------------------------------------
  384.  
  385.     I, the author, do not guarantee full functionality of  KI.  I  do
  386.     not take liability for any harm caused by the game to  the  user,
  387.     its computer or its data.
  388.  
  389.     KI is Shareware. It may be copied freely as far as the  files  are
  390.     unchanged and complete. I keep my right  to  cancel  this  general
  391.     license for any person / company at any time.  No  profit  may  be
  392.     made by distributing KI. Please inform me, if you think that KI is
  393.     sold for a too high price.
  394.     I agree with using the demo-version but not registering  (!),  but
  395.     i'd like to get at least a postcard to learn about someone  liking
  396.     the game.
  397.  
  398.     I approve portations to other computer-systems as far as they will
  399.     be Shareware, FreeWare or Public Domain.
  400.  
  401.     To potentional distributors:
  402.     If you would like your own version  (with  according  "Demo  for"-
  403.     text), please  write  to  me  and  tell  me  what  to  insert  (20
  404.     characters, Amiga-charset only) AND for which price  you  want  to
  405.     distribute KI.
  406.  
  407.     My (the authors) address is:
  408.  
  409.         Arnold Schommer
  410.         Erikaweg 16
  411.         40670 Meerbusch
  412.         FEDERAL REPUBLIC OF GERMANY
  413.  
  414.     (Sorry: i have no email-address)
  415.  
  416.  
  417. ----------------------------------------------------------------------------
  418. Miscellaneous
  419. ----------------------------------------------------------------------------
  420.  
  421.     (Apart from registrations) I'd like to get
  422.  
  423.     * your opinion about KI
  424.  
  425.     * Bug-Reports (please use the file 'BugReport' as form)
  426.  
  427.     * Translations of the program's text to other languages. The  file
  428.       'KI.cd' contains a standard (CatComp-) description of them.
  429.  
  430.